.. _CBaldurChitin Class:

==========================
CBaldurChitin Class
==========================

.. toctree::
   :maxdepth: 1

* :ref:`Overview<CBaldurChitin_Overview>`
* :ref:`Quick Reference<CBaldurChitin_QuickRef>`
* :ref:`Constructors<CBaldurChitin_Constructors>`
* :ref:`Methods<CBaldurChitin_Methods>`

----

.. _CBaldurChitin_Overview:

Overview
---------------

The structure used for this class is :ref:`CBaldurChitin<CBaldurChitin>`

----

.. _CBaldurChitin_QuickRef:

Quick Reference
---------------

+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Quick Ref**                                                                                                                                                                                                                                                                                                                      |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CBaldurChitin\:\:CBaldurChitin**\(int argc, char\*\* argv)                                                                                                                                                                                                                                                                  |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CBaldurChitin\:\:~CBaldurChitin**\()                                                                                                                                                                                                                                                                                        |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CBaldurChitin\:\:AddPlayedMovie**\(:ref:`CResRef<CResRef>`\& cResMovie)                                                                                                                                                                                                                                                     |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual :ref:`CRes<CRes>`\* **CBaldurChitin\:\:AllocResObject**\(int nType)                                                                                                                                                                                                                                                        |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:AsynchronousUpdate**\(unsigned int uTimerID, unsigned int uMsg, unsigned long dwUser, unsigned long dw1, unsigned long dw2)                                                                                                                                                                        |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:BroadcastMultiplayerProgressBarInfo**\()                                                                                                                                                                                                                                                           |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CBaldurChitin\:\:CheckGUISong**\()                                                                                                                                                                                                                                                                                          |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CBaldurChitin\:\:ConfirmQuit**\()                                                                                                                                                                                                                                                                                    |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned char **CBaldurChitin\:\:CutsceneModeActive**\()                                                                                                                                                                                                                                                                   |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CBaldurChitin\:\:FontRectOutline**\()                                                                                                                                                                                                                                                                                |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CBaldurChitin\:\:GetEAXActive**\()                                                                                                                                                                                                                                                                                   |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:GetGameSpyCode**\(:ref:`CString<CString>`\& sGameSpyCode)                                                                                                                                                                                                                                          |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:GetGameSpyGameName**\(:ref:`CString<CString>`\& sGameSpyName)                                                                                                                                                                                                                                      |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual :ref:`CString<CString>`\& **CBaldurChitin\:\:GetIconRes**\()                                                                                                                                                                                                                                                               |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned long **CBaldurChitin\:\:GetIDSBadDeskTopBitDepth**\()                                                                                                                                                                                                                                                             |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned long **CBaldurChitin\:\:GetIDSChoosePixelFormat**\()                                                                                                                                                                                                                                                              |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned long **CBaldurChitin\:\:GetIDSExclusiveMode**\()                                                                                                                                                                                                                                                                  |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned long **CBaldurChitin\:\:GetIDSInvalidVideoMode**\()                                                                                                                                                                                                                                                               |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned long **CBaldurChitin\:\:GetIDSOpenGLDll**\()                                                                                                                                                                                                                                                                      |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned long **CBaldurChitin\:\:GetIDSSetGameBitDepth**\()                                                                                                                                                                                                                                                                |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned long **CBaldurChitin\:\:GetIDSSetGameResolution**\()                                                                                                                                                                                                                                                              |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned long **CBaldurChitin\:\:GetIDSSetPixelFormat**\()                                                                                                                                                                                                                                                                 |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned long **CBaldurChitin\:\:GetIDSWindowsFonts**\()                                                                                                                                                                                                                                                                   |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual const char\* **CBaldurChitin\:\:GetKeyFileName**\()                                                                                                                                                                                                                                                                        |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual long **CBaldurChitin\:\:GetMovieVolume**\()                                                                                                                                                                                                                                                                                |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned short **CBaldurChitin\:\:GetMultiplayerDirectPlayPort**\()                                                                                                                                                                                                                                                        |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned short **CBaldurChitin\:\:GetMultiplayerGameSpyPort**\()                                                                                                                                                                                                                                                           |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned char **CBaldurChitin\:\:GetNumberSoundChannels**\()                                                                                                                                                                                                                                                               |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:GetPanicCDStrings**\(:ref:`CString<CString>`\& sMediaRemoved, :ref:`CString<CString>`\& sPlaceCD, :ref:`CString<CString>`\& sInDrive)                                                                                                                                                              |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CStringList<CStringList>`\* **CBaldurChitin\:\:GetPlayedMovies**\()                                                                                                                                                                                                                                                          |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:GetScreenShotFilePrefix**\(:ref:`CString<CString>`\& szGameFileName)                                                                                                                                                                                                                               |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual unsigned char **CBaldurChitin\:\:GetSoundEnvironment**\(:ref:`CString<CString>` stAreaRef, unsigned long\& dwEnvironment, float\& fDamping, float\& fDecay, float\& fVolume, float\& fReverbLevel)                                                                                                                         |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CBaldurChitin\:\:Init**\()                                                                                                                                                                                                                                                                                                  |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CBaldurChitin\:\:Is3DSound**\(int nChannel)                                                                                                                                                                                                                                                                          |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CBaldurChitin\:\:LoadDialogFiles**\()                                                                                                                                                                                                                                                                                       |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:LoadOptions**\()                                                                                                                                                                                                                                                                                   |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void __cdecl **CBaldurChitin\:\:Log**\(const char\* format, ...) = 0                                                                                                                                                                                                                                                       |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CBaldurChitin\:\:MessageCallback**\(unsigned char\* pData, unsigned long dwSize)                                                                                                                                                                                                                                     |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:OnMixerInitialize**\()                                                                                                                                                                                                                                                                             |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:OnMultiplayerPlayerJoin**\(int playerID, :ref:`CString<CString>`\& sPlayerName)                                                                                                                                                                                                                    |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:OnMultiplayerPlayerLeave**\(int playerID, :ref:`CString<CString>`\& sPlayerName)                                                                                                                                                                                                                   |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:OnMultiplayerPlayerVisible**\(int playerID)                                                                                                                                                                                                                                                        |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:OnMultiplayerSessionClose**\()                                                                                                                                                                                                                                                                     |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:OnMultiplayerSessionOpen**\(:ref:`CString<CString>`\& sJoinedGame, :ref:`CString<CString>`\& sDroppedGame, :ref:`CString<CString>`\& sLeftGame)                                                                                                                                                    |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:OnMultiplayerSessionToClose**\()                                                                                                                                                                                                                                                                   |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:PreLoadFonts**\()                                                                                                                                                                                                                                                                                  |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CBaldurChitin\:\:SaveOptions**\()                                                                                                                                                                                                                                                                                           |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:SetProgressBar**\(unsigned char bEnabled, long nProgressBarCaption, int nBytesCopied, int nTotalBytes, unsigned char bTravel, long nParchmentCaption, unsigned char bWaiting, long nWaitingReason, unsigned char bDisplayMinibars, unsigned char bTimeoutCounter, unsigned long nSecondsToTimeout) |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:SetProgressBarActivateEngine**\(int bValue)                                                                                                                                                                                                                                                        |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:SetSoundVolumes**\()                                                                                                                                                                                                                                                                               |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:SetupPanels**\()                                                                                                                                                                                                                                                                                   |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:ShutDown**\(int nLineNumber, char\* szFileName, const char\* text)                                                                                                                                                                                                                                 |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:SynchronousUpdate**\()                                                                                                                                                                                                                                                                             |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CBaldurChitin\:\:UnloadFonts**\()                                                                                                                                                                                                                                                                                   |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


----

.. _CBaldurChitin_Constructors:

Constructors
---------------

+---------------------------------------------------------------------+------------------------------------------------------+
| **Name**                                                            | **Description**                                      |
+---------------------------------------------------------------------+------------------------------------------------------+
| :ref:`CBaldurChitin\:\:CBaldurChitin<CBaldurChitinCBaldurChitin>`   | Constructs a ``CBaldurChitin`` object                |
+---------------------------------------------------------------------+------------------------------------------------------+
| :ref:`CBaldurChitin\:\:~CBaldurChitin<CBaldurChitin~CBaldurChitin>` | Destroys a ``CBaldurChitin`` object                  |
+---------------------------------------------------------------------+------------------------------------------------------+

.. _CBaldurChitinCBaldurChitin:

CBaldurChitin\:\:CBaldurChitin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Constructs a ``CBaldurChitin`` object

::

   void CBaldurChitin::CBaldurChitin(
      int argc, 
      char** argv);

**Parameters**

* ``int`` *argc* - An integer that contains the count of arguments that follow in argv
* ``char``\*\* *argv* - An array of null-terminated strings representing command-line arguments

**Remarks**

By convention, ``argv[0]`` is the command with which the program is invoked, ``argv[1]`` is the first command-line argument, and so on.


Constructs a ``CBaldurChitin`` object

----

.. _CBaldurChitin~CBaldurChitin:

CBaldurChitin\:\:~CBaldurChitin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Destroys the ``CBaldurChitin`` object

::

   void CBaldurChitin::~CBaldurChitin()

**Remarks**

Destroys the ``CBaldurChitin`` object



----

.. _CBaldurChitin_Methods:

Methods
---------------

+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **Name**                                                                                                      | **Description**                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:AddPlayedMovie<CBaldurChitinAddPlayedMovie>`                                           | Add a movie to the already played list                                                  |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:AllocResObject<CBaldurChitinAllocResObject>`                                           | Creates and allocates memory for a resource                                             |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:AsynchronousUpdate<CBaldurChitinAsynchronousUpdate>`                                   |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:BroadcastMultiplayerProgressBarInfo<CBaldurChitinBroadcastMultiplayerProgressBarInfo>` | Broadcast to all connected sessions the progress bar information                        |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:CheckGUISong<CBaldurChitinCheckGUISong>`                                               |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:ConfirmQuit<CBaldurChitinConfirmQuit>`                                                 | Displays a prompt to confirm if players wishes to quit, save before quit, etc           |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:CutsceneModeActive<CBaldurChitinCutsceneModeActive>`                                   | Determines if the cutscene mode is active or not (for dreams etc)                       |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:FontRectOutline<CBaldurChitinFontRectOutline>`                                         |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetEAXActive<CBaldurChitinGetEAXActive>`                                               | Determines if the EAX sound feature is active or not                                    |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetGameSpyCode<CBaldurChitinGetGameSpyCode>`                                           | Gets the game spy code                                                                  |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetGameSpyGameName<CBaldurChitinGetGameSpyGameName>`                                   | Gets the game spy game name                                                             |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetIconRes<CBaldurChitinGetIconRes>`                                                   | Gets default icon resolution                                                            |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetIDSBadDeskTopBitDepth<CBaldurChitinGetIDSBadDeskTopBitDepth>`                       |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetIDSChoosePixelFormat<CBaldurChitinGetIDSChoosePixelFormat>`                         |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetIDSExclusiveMode<CBaldurChitinGetIDSExclusiveMode>`                                 |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetIDSInvalidVideoMode<CBaldurChitinGetIDSInvalidVideoMode>`                           |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetIDSOpenGLDll<CBaldurChitinGetIDSOpenGLDll>`                                         |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetIDSSetGameBitDepth<CBaldurChitinGetIDSSetGameBitDepth>`                             |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetIDSSetGameResolution<CBaldurChitinGetIDSSetGameResolution>`                         |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetIDSSetPixelFormat<CBaldurChitinGetIDSSetPixelFormat>`                               |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetIDSWindowsFonts<CBaldurChitinGetIDSWindowsFonts>`                                   |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetKeyFileName<CBaldurChitinGetKeyFileName>`                                           | Returns a pointer to a string containing the default key file (usually ``chitin.key``)  |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetMovieVolume<CBaldurChitinGetMovieVolume>`                                           | Returns movie volume                                                                    |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetMultiplayerDirectPlayPort<CBaldurChitinGetMultiplayerDirectPlayPort>`               | Returns port no used in DirectPlay                                                      |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetMultiplayerGameSpyPort<CBaldurChitinGetMultiplayerGameSpyPort>`                     | Returns port no used in GameSpy                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetNumberSoundChannels<CBaldurChitinGetNumberSoundChannels>`                           | Returns number of sound channels supported by local machine                             |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetPanicCDStrings<CBaldurChitinGetPanicCDStrings>`                                     | Legacy function for when game was distributed on CD/DVD                                 |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetPlayedMovies<CBaldurChitinGetPlayedMovies>`                                         | Returns a list of movies that have been played                                          |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetScreenShotFilePrefix<CBaldurChitinGetScreenShotFilePrefix>`                         |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:GetSoundEnvironment<CBaldurChitinGetSoundEnvironment>`                                 |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:Init<CBaldurChitinInit>`                                                               | Initialize CBaldurChitin class                                                          |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:Is3DSound*<CBaldurChitinIs3DSound>`                                                    | Returns if 3D sound is supported on local machine                                       |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:LoadDialogFiles<CBaldurChitinLoadDialogFiles>`                                         | Load dialog files                                                                       |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:LoadOptions<CBaldurChitinLoadOptions>`                                                 | Load options                                                                            |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:Log<CBaldurChitinLog>`                                                                 | Output text to a log, similar to printf and uses variable no of arguments               |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:MessageCallback<CBaldurChitinMessageCallback>`                                         |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:OnMixerInitialize<CBaldurChitinOnMixerInitialize>`                                     |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:OnMultiplayerPlayerJoin<CBaldurChitinOnMultiplayerPlayerJoin>`                         | Event action when a player joins a multiplayer game session                             |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:OnMultiplayerPlayerLeave<CBaldurChitinOnMultiplayerPlayerLeave>`                       | Event action when a player leaves a multiplayer game session                            |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:OnMultiplayerPlayerVisible<CBaldurChitinOnMultiplayerPlayerVisible>`                   | Event action when a player in a multiplayer game session becomes visible to others      |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:OnMultiplayerSessionClose<CBaldurChitinOnMultiplayerSessionClose>`                     | Event action when a multiplayer game session closes                                     |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:OnMultiplayerSessionOpen<CBaldurChitinOnMultiplayerSessionOpen>`                       | Event action when a multiplayer game session opens                                      |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:OnMultiplayerSessionToClose<CBaldurChitinOnMultiplayerSessionToClose>`                 | Event action when a multiplayer game session is about to close                          |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:PreLoadFonts<CBaldurChitinPreLoadFonts>`                                               | Preload fonts for game                                                                  |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:SaveOptions<CBaldurChitinSaveOptions>`                                                 | Save options                                                                            |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:SetProgressBar<CBaldurChitinSetProgressBar>`                                           | Set progress bar on screen                                                              |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:SetProgressBarActivateEngine<CBaldurChitinSetProgressBarActivateEngine>`               |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:SetSoundVolumes<CBaldurChitinSetSoundVolumes>`                                         |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:SetupPanels<CBaldurChitinSetupPanels>`                                                 |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:ShutDown<CBaldurChitinShutDown>`                                                       |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:SynchronousUpdate<CBaldurChitinSynchronousUpdate>`                                     |                                                                                         |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CBaldurChitin\:\:UnloadFonts<CBaldurChitinUnloadFonts>`                                                 | Unload fonts previously loaded by game engine, typically when game is closing           |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+

----


.. _CBaldurChitinAddPlayedMovie:

CBaldurChitin\:\:AddPlayedMovie
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Add a movie to the already played list

::

   void CBaldurChitin::AddPlayedMovie(CResRef& cResMovie);

**Parameters**

* :ref:`CResRef<CResRef>`\& *cResMovie* - resource reference of movie to add to played list

**Remarks**




----

.. _CBaldurChitinAllocResObject:

CBaldurChitin\:\:AllocResObject
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Creates and allocates memory for a resource

::

   virtual CRes* CBaldurChitin::AllocResObject(int nType);

**Parameters**

* ``int`` *nType* - type of resource to create

**Return Value**

Returns a :ref:`CRes<CRes>` object

**Remarks**



----

.. _CBaldurChitinAsynchronousUpdate:

CBaldurChitin\:\:AsynchronousUpdate
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual void CBaldurChitin::AsynchronousUpdate(
      unsigned int uTimerID, 
      unsigned int uMsg, 
      unsigned long dwUser, 
      unsigned long dw1, 
      unsigned long dw2);

**Parameters**

* ``unsigned int`` *uTimerID* - 
* ``unsigned int`` *uMsg* - 
* ``unsigned long`` *dwUser* - 
* ``unsigned long`` *dw1* - 
* ``unsigned long`` *dw2* - 

**Remarks**



----

.. _CBaldurChitinBroadcastMultiplayerProgressBarInfo:

CBaldurChitin\:\:BroadcastMultiplayerProgressBarInfo
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Broadcast to all connected sessions the progress bar information

::

   virtual void CBaldurChitin::BroadcastMultiplayerProgressBarInfo();
 

**Remarks**



.. _CBaldurChitinCheckGUISong:

CBaldurChitin\:\:CheckGUISong
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   void CBaldurChitin::CheckGUISong();


**Remarks**



----

.. _CBaldurChitinConfirmQuit:

CBaldurChitin\:\:ConfirmQuit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Displays a prompt to confirm if players wishes to quit, save before quit, etc

::

   virtual int CBaldurChitin::ConfirmQuit();

**Return Value**

Returns an ``int``

**Remarks**



----

.. _CBaldurChitinCutsceneModeActive:

CBaldurChitin\:\:CutsceneModeActive
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Determines if the cutscene mode is active or not (for dreams etc)

::

   virtual unsigned char CBaldurChitin::CutsceneModeActive();

**Return Value**

Returns a ``unsigned char``

**Remarks**



----

.. _CBaldurChitinFontRectOutline:

CBaldurChitin\:\:FontRectOutline
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual int CBaldurChitin::FontRectOutline();

**Return Value**

Returns an ``int``

**Remarks**




----

.. _CBaldurChitinGetEAXActive:

CBaldurChitin\:\:GetEAXActive
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Determines if the EAX sound feature is active or not

::

   virtual int CBaldurChitin::GetEAXActive();

**Return Value**

Returns an ``int`` representing true ``1`` or false ``0``

**Remarks**



----

.. _CBaldurChitinGetGameSpyCode:

CBaldurChitin\:\:GetGameSpyCode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Gets the game spy code

::

   virtual void CBaldurChitin::GetGameSpyCode(CString& sGameSpyCode);

**Parameters**

* :ref:`CString<CString>`\& *sGameSpyCode* - address of string to store the game spy code in

**Remarks**



----

.. _CBaldurChitinGetGameSpyGameName:

CBaldurChitin\:\:GetGameSpyGameName
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Gets the game spy game name

::

   virtual void CBaldurChitin::GetGameSpyGameName(CString& sGameSpyName);

**Parameters**

* :ref:`CString<CString>`\& *sGameSpyName* - address of string to store the game spy name in

**Remarks**



----

.. _CBaldurChitinGetIconRes:

CBaldurChitin\:\:GetIconRes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Gets default icon resolution

::

   virtual CString& CBaldurChitin::GetIconRes();

**Return Value**

Returns a :ref:`CString<CString>`\&

**Remarks**



----

.. _CBaldurChitinGetIDSBadDeskTopBitDepth:

CBaldurChitin\:\:GetIDSBadDeskTopBitDepth
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual unsigned long CBaldurChitin::GetIDSBadDeskTopBitDepth();

**Return Value**

Returns an ``unsigned long``

**Remarks**



----

.. _CBaldurChitinGetIDSChoosePixelFormat:

CBaldurChitin\:\:GetIDSChoosePixelFormat
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual unsigned long CBaldurChitin::GetIDSChoosePixelFormat();

**Return Value**

Returns an ``unsigned long``

**Remarks**



----

.. _CBaldurChitinGetIDSExclusiveMode:

CBaldurChitin\:\:GetIDSExclusiveMode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual unsigned long CBaldurChitin::GetIDSExclusiveMode();

**Return Value**

Returns an ``unsigned long``

**Remarks**




----

.. _CBaldurChitinGetIDSInvalidVideoMode:

CBaldurChitin\:\:GetIDSInvalidVideoMode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual unsigned long CBaldurChitin::GetIDSInvalidVideoMode();

**Return Value**

Returns an ``unsigned long``

**Remarks**



----

.. _CBaldurChitinGetIDSOpenGLDll:

CBaldurChitin\:\:GetIDSOpenGLDll
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual unsigned long CBaldurChitin::GetIDSOpenGLDll();

**Return Value**

Returns an ``unsigned long``

**Remarks**



----

.. _CBaldurChitinGetIDSSetGameBitDepth:

CBaldurChitin\:\:GetIDSSetGameBitDepth
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual unsigned long CBaldurChitin::GetIDSSetGameBitDepth();

**Return Value**

Returns an ``unsigned long``

**Remarks**



----

.. _CBaldurChitinGetIDSSetGameResolution:

CBaldurChitin\:\:GetIDSSetGameResolution
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual unsigned long CBaldurChitin::GetIDSSetGameResolution();

**Return Value**

Returns an ``unsigned long``

**Remarks**



----

.. _CBaldurChitinGetIDSSetPixelFormat:

CBaldurChitin\:\:GetIDSSetPixelFormat
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual unsigned long CBaldurChitin::GetIDSSetPixelFormat();

**Return Value**

Returns an ``unsigned long``

**Remarks**



----

.. _CBaldurChitinGetIDSWindowsFonts:

CBaldurChitin\:\:GetIDSWindowsFonts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual unsigned long CBaldurChitin::GetIDSWindowsFonts();

**Return Value**

Returns an ``unsigned long``

**Remarks**



----

.. _CBaldurChitinGetKeyFileName:

CBaldurChitin\:\:GetKeyFileName
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Returns a pointer to a string containing the default key file (usually ``chitin.key``) for the game engine

::

   virtual const char* CBaldurChitin::GetKeyFileName();

**Return Value**

Returns ``const char``\*, a pointer to a string containing key file

**Remarks**




----

.. _CBaldurChitinGetMovieVolume:

CBaldurChitin\:\:GetMovieVolume
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Returns movie volume

::

   virtual long CBaldurChitin::GetMovieVolume();

**Return Value**

Returns ``long`` representing movie volume

**Remarks**



----

.. _CBaldurChitinGetMultiplayerDirectPlayPort:

CBaldurChitin\:\:GetMultiplayerDirectPlayPort
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Returns port no used in DirectPlay

::

   virtual unsigned short CBaldurChitin::GetMultiplayerDirectPlayPort();

**Return Value**

Returns an ``unsigned short`` representing the port

**Remarks**



----

.. _CBaldurChitinGetMultiplayerGameSpyPort:

CBaldurChitin\:\:GetMultiplayerGameSpyPort
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Returns port no used in GameSpy

::

   virtual unsigned short CBaldurChitin::GetMultiplayerGameSpyPort();

**Return Value**

Returns an ``unsigned short`` representing the port

**Remarks**



----

.. _CBaldurChitinGetNumberSoundChannels:

CBaldurChitin\:\:GetNumberSoundChannels
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Returns number of sound channels supported by local machine

::

   virtual unsigned char CBaldurChitin::GetNumberSoundChannels();

**Return Value**

Returns ``unsigned char``

**Remarks**



----

.. _CBaldurChitinGetPanicCDStrings:

CBaldurChitin\:\:GetPanicCDStrings
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Legacy function for when game was distributed on CD/DVD

::

   virtual void CBaldurChitin::GetPanicCDStrings(
      CString& sMediaRemoved, 
      CString& sPlaceCD, 
      CString& sInDrive);

**Parameters**

* :ref:`CString<CString>`\& *sMediaRemoved* - address of string to store media string
* :ref:`CString<CString>`\& *sPlaceCD* - address of string to store place cd/dvd string
* :ref:`CString<CString>`\& *sInDrive* - address of string to store in drive string

**Remarks**



----

.. _CBaldurChitinGetPlayedMovies:

CBaldurChitin\:\:GetPlayedMovies
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Returns a list of movies that have been played

::

   CStringList* CBaldurChitin::GetPlayedMovies();

**Return Value**

Returns a :ref:`CStringList<CStringList>`\*

**Remarks**



----

.. _CBaldurChitinGetScreenShotFilePrefix:

CBaldurChitin\:\:GetScreenShotFilePrefix
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual void CBaldurChitin::GetScreenShotFilePrefix(CString& szGameFileName);

**Parameters**

* :ref:`CString<CString>`\& *szGameFileName* - address of string to store screenshot filename prefix to

**Remarks**




----

.. _CBaldurChitinGetSoundEnvironment:

CBaldurChitin\:\:GetSoundEnvironment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual unsigned char CBaldurChitin::GetSoundEnvironment(
      CString stAreaRef, 
      unsigned long& dwEnvironment, 
      float& fDamping, 
      float& fDecay, 
      float& fVolume, 
      float& fReverbLevel;

**Parameters**

* :ref:`CString<CString>` *stAreaRef* - string containing area resource reference
* ``unsigned long``\& *dwEnvironment* - address of long variable to store sound environment info
* ``float``\& *fDamping* - address of float variable to store sound damping value
* ``float``\& *fDecay* - address of float variable to store sound decay value
* ``float``\& *fVolume* - address of float variable to store sound volume
* ``float``\& *fReverbLevel* - address of float variable to store reverb level

**Return Value**

Returns ``unsigned char``

**Remarks**



----

.. _CBaldurChitinInit:

CBaldurChitin\:\:Init
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Initialize CBaldurChitin class

::

   void CBaldurChitin::Init();

**Remarks**



----

.. _CBaldurChitinIs3DSound:

CBaldurChitin\:\:Is3DSound
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Returns true if 3D sound is supported on local machine

::

   virtual int CBaldurChitin::Is3DSound(int nChannel);

**Parameters**

* ``int`` *nChannel* - 

**Return Value**

Returns an ``int`` representing true ``1`` or false ``0``

**Remarks**



----

.. _CBaldurChitinLoadDialogFiles:

CBaldurChitin\:\:LoadDialogFiles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Load dialog files

::

   void CBaldurChitin::LoadDialogFiles();

**Remarks**



.. _CBaldurChitinLoadOptions:

CBaldurChitin\:\:LoadOptions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Load options

::

   virtual void CBaldurChitin::LoadOptions();

**Remarks**



----

.. _CBaldurChitinLog:

CBaldurChitin\:\:Log
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Output text to a log, similar to printf and uses variable no of arguments after the format string

::

   virtual void __cdecl CBaldurChitin::Log(
      const char* format, 
      ...);

**Parameters**

* ``const char``\* *format* - special format string for handling other passed parameters
* ... - * *

**Remarks**



----

.. _CBaldurChitinMessageCallback:

CBaldurChitin\:\:MessageCallback
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual int CBaldurChitin::MessageCallback(
      unsigned char* pData, 
      unsigned long dwSize);

**Parameters**

* ``unsigned char``\* *pData* - pointer to data to send in message callback
* ``unsigned long`` *dwSize* - size of message callback data

**Return Value**

Returns ``int``

**Remarks**




----

.. _CBaldurChitinOnMixerInitialize:

CBaldurChitin\:\:OnMixerInitialize
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual void CBaldurChitin::OnMixerInitialize();

**Remarks**



----

.. _CBaldurChitinOnMultiplayerPlayerJoin:

CBaldurChitin\:\:OnMultiplayerPlayerJoin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Event action when a player joins a multiplayer game session

::

   virtual void CBaldurChitin::OnMultiplayerPlayerJoin(
      int playerID, 
      CString& sPlayerName);

**Parameters**

* ``int`` *playerID* - id of player joining multiplayer session
* :ref:`CString<CString>`\& *sPlayerName* - address of string variable that contains player name

**Remarks**



----

.. _CBaldurChitinOnMultiplayerPlayerLeave:

CBaldurChitin\:\:OnMultiplayerPlayerLeave
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Event action when a player leaves a multiplayer game session

::

   virtual void CBaldurChitin::OnMultiplayerPlayerLeave(
      int playerID, 
      CString& sPlayerName);

**Parameters**

* ``int`` *playerID* - id of player leaving multiplayer session
* :ref:`CString<CString>`\& *sPlayerName* - address of string variable that contains player name

**Remarks**



----

.. _CBaldurChitinOnMultiplayerPlayerVisible:

CBaldurChitin\:\:OnMultiplayerPlayerVisible
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Event action when a player in a multiplayer game session becomes visible to other existing players

::

   virtual void CBaldurChitin::OnMultiplayerPlayerVisible(int playerID);

**Parameters**

* ``int`` *playerID* - id of multiplayer player 

**Remarks**



----

.. _CBaldurChitinOnMultiplayerSessionClose:

CBaldurChitin\:\:OnMultiplayerSessionClose
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Event action when a multiplayer game session closes

::

   virtual void CBaldurChitin::OnMultiplayerSessionClose();

**Remarks**



----

.. _CBaldurChitinOnMultiplayerSessionOpen:

CBaldurChitin\:\:OnMultiplayerSessionOpen
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Event action when a multiplayer game session opens

::

   virtual void CBaldurChitin::OnMultiplayerSessionOpen(
      CString& sJoinedGame, 
      CString& sDroppedGame, 
      CString& sLeftGame);

**Parameters**

* :ref:`CString<CString>`\& *sJoinedGame* - address of string containing joined game text
* :ref:`CString<CString>`\& *sDroppedGame* - address of string containing dropped game text
* :ref:`CString<CString>`\& *sLeftGame* - address of string containing left game text

**Remarks**



----

.. _CBaldurChitinOnMultiplayerSessionToClose:

CBaldurChitin\:\:OnMultiplayerSessionToClose
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Event action when a multiplayer game session is about to close

::

   virtual void CBaldurChitin::OnMultiplayerSessionToClose();

**Remarks**




----

.. _CBaldurChitinPreLoadFonts:

CBaldurChitin\:\:PreLoadFonts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Preload fonts for game

::

   virtual void CBaldurChitin::PreLoadFonts();

**Remarks**



----

.. _CBaldurChitinSaveOptions:

CBaldurChitin\:\:SaveOptions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Save options

::

   void CBaldurChitin::SaveOptions();

**Remarks**



----

.. _CBaldurChitinSetProgressBar:

CBaldurChitin\:\:SetProgressBar
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Set progress bar on screen

::

   virtual void CBaldurChitin::SetProgressBar(
      unsigned char bEnabled, 
      long nProgressBarCaption, 
      int nBytesCopied, 
      int nTotalBytes, 
      unsigned char bTravel, 
      long nParchmentCaption, 
      unsigned char bWaiting, 
      long nWaitingReason, 
      unsigned char bDisplayMinibars, 
      unsigned char bTimeoutCounter, 
      unsigned long nSecondsToTimeout);

**Parameters**

* ``unsigned char`` *bEnabled* - 
* ``long`` *nProgressBarCaption* - 
* ``int`` *nBytesCopied* - 
* ``int`` *nTotalBytes* - 
* ``unsigned char`` *bTravel* - 
* ``long`` *nParchmentCaption* - 
* ``unsigned char`` *bWaiting* - 
* ``long`` *nWaitingReason* - 
* ``unsigned char`` *bDisplayMinibars* - 
* ``unsigned char`` *bTimeoutCounter* - 
* ``unsigned long`` *nSecondsToTimeout* - 

**Remarks**



----

.. _CBaldurChitinSetProgressBarActivateEngine:

CBaldurChitin\:\:SetProgressBarActivateEngine
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual void CBaldurChitin::SetProgressBarActivateEngine(int bValue);

**Parameters**

* ``int`` *bValue* - 

**Remarks**



----

.. _CBaldurChitinSetSoundVolumes:

CBaldurChitin\:\:SetSoundVolumes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual void CBaldurChitin::SetSoundVolumes();

**Remarks**



----

.. _CBaldurChitinSetupPanels:

CBaldurChitin\:\:SetupPanels
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual void CBaldurChitin::SetupPanels();

**Remarks**




----

.. _CBaldurChitinShutDown:

CBaldurChitin\:\:ShutDown
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual void CBaldurChitin::ShutDown(
      int nLineNumber, 
      char* szFileName, 
      const char* text);

**Parameters**

* ``int`` *nLineNumber* - line number that shutdown occured at
* ``char``\* *szFileName* - file that shutdown occured at
* ``const char``\* *text* - message text for shutdown reason to output to log

**Remarks**




----

.. _CBaldurChitinSynchronousUpdate:

CBaldurChitin\:\:SynchronousUpdate
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   virtual void CBaldurChitin::SynchronousUpdate();

**Remarks**




----

.. _CBaldurChitinUnloadFonts:

CBaldurChitin\:\:UnloadFonts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Unload fonts previously loaded by game engine, typically when game is closing.

::

   virtual void CBaldurChitin::UnloadFonts();

**Remarks**